ConfigFile V2 (Component) #2862

EronWright · 2024-03-05T23:07:15Z

Proposed changes

This PR implements a new ConfigFile resource (v2) as a Pulumi multi-language component (MLC). The new resource is offered side-by-side with the existing (v1) resource; it is not a drop-in replacement at this time.

Some notable differences with respect to the previous (overlay) implementations:

Implemented as an MLC to have a consistent implementation across SDKs and to extend support for YAML and Java.
The component name is used as a prefix for the child resource names. Use the resourcePrefix property to override. Note that the resourcePrefix is not applied to the Kubernetes object names.
Transformations aren't supported (yet). Support for Pulumi-style transformation is being tracked here, and Kubernetes-style transformation may come in future.
The file property is required and the file must exist.

Examples

Here's some usage examples.

YAML

name: issue-2785
runtime: yaml
description: A minimal Kubernetes Pulumi YAML program
resources:
  cf:
    type: kubernetes:yaml/v2:ConfigFile
    properties:
      file: ./manifest.yaml

NodeJS

import * as pulumi from "@pulumi/pulumi";
import * as kubernetes from "@pulumi/kubernetes";

const configFile = new kubernetes.yaml.v2.ConfigFile("my-config-file", {
    file: "./manifest.yaml"
});

const cm = configFile.resources[0].apply(r => r as kubernetes.core.v1.ConfigMap);
export const configmap = pulumi.interpolate`${cm.metadata.namespace}/${cm.metadata.name}`;

Testing

New tests of ConfigFile were added to the test suite for the "yaml/v2" package.

Related issues (optional)

Closes #2785

provider/pkg/provider/yaml/v2/configFile.go

provider/pkg/gen/examples/overlays/configGroupV2.md

provider/pkg/gen/overlays.go

provider/pkg/provider/yaml/v2/configfile.go

provider/pkg/gen/overlays.go

rquitales

LGTM - Changes are aligned with the introductions made in the ConfigGroup PR.

github-actions · 2024-03-08T21:47:18Z

Does the PR have any schema changes?

Looking good! No breaking changes found.

New resources:

yaml/v2.ConfigFile

codecov · 2024-03-08T21:51:05Z

Codecov Report

Attention: Patch coverage is 76.47059% with 8 lines in your changes are missing coverage. Please review.

Project coverage is 26.84%. Comparing base (6951ed5) to head (0b0b7c9).

Files	Patch %	Lines
provider/pkg/provider/yaml/v2/configfile.go	80.64%	3 Missing and 3 partials ⚠️
provider/pkg/gen/schema.go	0.00%	2 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #2862      +/-   ##
==========================================
+ Coverage   26.62%   26.84%   +0.21%     
==========================================
  Files          52       53       +1     
  Lines        7688     7722      +34     
==========================================
+ Hits         2047     2073      +26     
- Misses       5471     5476       +5     
- Partials      170      173       +3

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [@pulumi/kubernetes](https://pulumi.com) ([source](https://togithub.com/pulumi/pulumi-kubernetes)) | dependencies | minor | [`4.9.1` -> `4.10.0`](https://renovatebot.com/diffs/npm/@pulumi%2fkubernetes/4.9.1/4.10.0) | --- > [!WARNING] > Some dependencies could not be looked up. Check the Dependency Dashboard for more information. --- ### Release Notes <details> <summary>pulumi/pulumi-kubernetes (@pulumi/kubernetes)</summary> ### [`v4.10.0`](https://togithub.com/pulumi/pulumi-kubernetes/blob/HEAD/CHANGELOG.md#4100-April-11-2024) [Compare Source](https://togithub.com/pulumi/pulumi-kubernetes/compare/v4.9.1...v4.10.0) - ConfigGroup V2 ([https://github.com/pulumi/pulumi-kubernetes/pull/2844](https://togithub.com/pulumi/pulumi-kubernetes/pull/2844)) - ConfigFile V2 ([https://github.com/pulumi/pulumi-kubernetes/pull/2862](https://togithub.com/pulumi/pulumi-kubernetes/pull/2862)) - Bugfix for ambiguous kinds ([https://github.com/pulumi/pulumi-kubernetes/pull/2889](https://togithub.com/pulumi/pulumi-kubernetes/pull/2889)) - \[yaml/v2] Support for resource ordering [https://github.com/pulumi/pulumi-kubernetes/pull/2894](https://togithub.com/pulumi/pulumi-kubernetes/pull/2894)4) - Bugfix for deployment await logic not referencing the correct deployment status ([https://github.com/pulumi/pulumi-kubernetes/pull/2943](https://togithub.com/pulumi/pulumi-kubernetes/pull/2943)) ##### New Features A new MLC-based implementation of `ConfigGroup` and of `ConfigFile` is now available in the "yaml/v2" package. These resources are usable in all Pulumi languages, including Pulumi YAML and in the Java Pulumi SDK. Note that transformations aren't supported in this release (see [https://github.com/pulumi/pulumi/issues/12996](https://togithub.com/pulumi/pulumi/issues/12996)). </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://togithub.com/renovatebot/renovate).  Co-authored-by: lumiere-bot[bot] <98047013+lumiere-bot[bot]@users.noreply.github.com>

EronWright requested review from rquitales and lblackstone March 5, 2024 23:17

blampe reviewed Mar 5, 2024

View reviewed changes

provider/pkg/provider/yaml/v2/configFile.go Outdated Show resolved Hide resolved

provider/pkg/provider/yaml/v2/configFile.go Outdated Show resolved Hide resolved

rquitales reviewed Mar 6, 2024

View reviewed changes

danielrbradley reviewed Mar 6, 2024

View reviewed changes

provider/pkg/gen/overlays.go Outdated Show resolved Hide resolved

EronWright self-assigned this Mar 6, 2024

EronWright force-pushed the eronwright/issue-2784-configgroup branch 2 times, most recently from f28f9f1 to 006dd0d Compare March 8, 2024 00:20

EronWright force-pushed the eronwright/issue-2785-configfile branch from 45cd459 to d4a60d9 Compare March 8, 2024 07:25

rquitales approved these changes Mar 8, 2024

View reviewed changes

EronWright force-pushed the eronwright/issue-2784-configgroup branch from 006dd0d to 4388af3 Compare March 8, 2024 20:17

Base automatically changed from eronwright/issue-2784-configgroup to master March 8, 2024 20:59

EronWright added 7 commits March 8, 2024 13:25

schema

20ce1c4

provider implementation and tests

4f59dad

changelog

5b2a396

rename files

29a776c

simplify resourcePrefix

39f2fde

feedback

2a07e3a

generate sdk

e239108

EronWright force-pushed the eronwright/issue-2785-configfile branch from 02ca515 to e239108 Compare March 8, 2024 21:42

java SDK schema fix

0b0b7c9

EronWright enabled auto-merge (squash) March 8, 2024 22:13

EronWright merged commit c59ddff into master Mar 8, 2024
20 checks passed

EronWright deleted the eronwright/issue-2785-configfile branch March 8, 2024 22:54

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

ConfigFile V2 (Component) #2862

ConfigFile V2 (Component) #2862

EronWright commented Mar 5, 2024 •

edited

Loading

rquitales left a comment

github-actions bot commented Mar 8, 2024

codecov bot commented Mar 8, 2024 •

edited

Loading

ConfigFile V2 (Component) #2862

ConfigFile V2 (Component) #2862

Conversation

EronWright commented Mar 5, 2024 • edited Loading

Proposed changes

Examples

YAML

NodeJS

Testing

Related issues (optional)

rquitales left a comment

Choose a reason for hiding this comment

github-actions bot commented Mar 8, 2024

Does the PR have any schema changes?

New resources:

codecov bot commented Mar 8, 2024 • edited Loading

Codecov Report

EronWright commented Mar 5, 2024 •

edited

Loading

codecov bot commented Mar 8, 2024 •

edited

Loading